Going further with CDI 1.2

Antonin Stefanutti

  • Software Engineer
  • Murex
  • www.murex.com
  • @astefanut
  • github.com/astefanutti
Slides available at github.com/astefanutti/further-cdi

CDI @ Murex

murex
CDI as the productivity ecosystem to build connectivity interfaces

CDI @ Murex

before after

Antoine Sabot-Durand

  • Senior Software Engineer
  • CDI co-spec lead, Java EE 8 EG
  • Red Hat, Inc.
  • @antoine_sd
  • www.next-presso.com
  • github.com/antoinesd

Should I stay or should I go?

  • A talk about advanced CDI
  • Might be hard for beginners
  • Don’t need to be a CDI guru

Should I stay or should I go ?

If you know the most of these you can stay

More concretely

What’s included:
  1. Real use cases from real life with real users
  2. New approach to introduce portable extension concepts
  3. Code in IDE with tests
What’s not included:
  1. Introduction to CDI
  2. Old content on extension
  3. Work with Context (need 2 more hours)

Tools used in the code 1/2

Apache Deltaspike

deltaspike
  1. Apache DeltaSpike is a great CDI toolbox
  2. Provide helpers to develop extension
  3. And a collection of modules like:
    1. Security
    2. Data
    3. Scheduler
  4. More info on deltaspike.apache.org

Tools used in the code 2/2

Arquillian

arquillian
  1. Arquillian is an integration test platform
  2. It integrates with JUnit
  3. Create your deployment in a dedicated method
  4. And launch your tests against the container of your choice
  5. We’ll use the weld-se-embedded and weld-ee-embedded container
  6. The right solution to test Java EE code
  7. More info on arquillian.org

Agenda

  • Meet CDI SPI
  • Introducing CDI Extensions
  • Metrics CDI
  • CDI Quizz
  • Camel CDI
Slides available at astefanutti.github.io/further-cdi

Meet CDI SPI

3d-chess ==!

SPI can be split in 4 parts

Type meta-model
CDI meta-model
CDI entry points
SPI dedicated to extensions

Why Having a Type Meta-Model?

Because @Annotations are configuration
but they are also read-only
So to configure we need a mutable meta-model…​
…​for annotated types

SPI for Type meta-model

type meta

SPI Dedicated to CDI Meta-Model

cdi meta

This SPI can be used in your code 1

InjectionPoint can be used to get info about what’s being injected
@Qualifier
@Retention(RUNTIME)
@Target({TYPE, METHOD, FIELD, PARAMETER})
public @interface HttpParam {
  @Nonbinding public String value()
}
...
@Produces @HttpParam("")
String getParamValue(InjectionPoint ip,HttpServletRequest req) {
  return req.getParameter(ip.getAnnotated().getAnnotation(HttpParam.class).value())
}
...
@HttpParam("productId") @Inject String productId

This SPI can be used in your code 2

InjectionPoint contains info about requested type at @Inject
public class MyMapProducer() {
  @Produces
  public <K, V> Map<K, V> produceMap(InjectionPoint ip) {
       if (valueIsNumber(((ParameterizedType)ip.getType())))
           return new TreeMap<K, V>()
       return new HashMap<K, V>()
  }

  private boolean valueIsNumber(ParameterizedType t) {
        Class<?> valueClass = (Class<?>) t.getActualTypeArguments()[1]
        return Number.class.isAssignableFrom(valueClass)
  }
}

SPI providing CDI Entry points

entry points

SPI Dedicated to Extensions

spi extensions

All these SPI interaces are events containing meta-model SPI

These events fired at boot time can only be observed in a CDI extension
For instance:

processAnnotatedTypeCart

A ProcessAnnotatedType<T> event is triggered for each type discovered at boot time
Observing ProcessAnnotatedType<Foo> allow you to prevent Foo to become a bean by calling ProcessAnnotatedType#veto()

Introducing CDI Portable Extensions

Portable Extensions

powerful
One of the most powerful feature of the CDI specification
Not really popularized, partly due to:
  1. Their high level of abstraction
  2. The good knowledge on Basic CDI and SPI
  3. Lack of information (CDI is often reduced to a basic DI solution)

Extensions What for?

To integrate 3rd party libraries, frameworks or legacy components
To change exisiting configuration or behavior
To extend CDI and Java EE
thanks to them, Java EE can evolve between major release

Extensions How?

rubik
Observing SPI Events at boot time according to BeanManger Lifecycle
Checking what meta-data are being created
Modifying these meta-data or creating new ones

More concretely

Service provider of the service javax.enterprise.inject.spi.Extension declared in META-INF/services
Just put the fully qualified name of your extension class in this file
import javax.enterprise.event.Observes;
import javax.enterprise.inject.spi.Extension;

class CdiExtension implements Extension {

    void beforeBeanDiscovery(@Observes BeforeBeanDiscovery bbd) {
    }
    ...

    void afterDeploymentValidation(@Observes AfterDeploymentValidation adv) {
    }
}

Bean Manager Lifecycle

lifecycle simple lifecycle legend

Example: Ignoring JPA Entities

The following extension prevents CDI to manage entities
This is a commonly admitted good practice
public class VetoEntity implements Extension {

    void vetoEntity(@Observes @WithAnnotations(Entity.class)
                    ProcessAnnotatedType<?> pat) {
        pat.veto();
    }
}

Remember

Extensions are launched during
bootstrap and are based on CDI events

Once the application is bootstrapped,
the Bean Manager is in read-only mode (no runtime bean registration)

You only have to @Observes built-in CDI events to create your extensions

3rd party Library

How to integrate a 3rd party Library (Dropwizard Metrics) into the CDI Programming Model

About Dropwizard Metrics

Provides different metric types: Counter, Gauge, Meter, Timer, …​
Provides different reporter: JMX, console, SLF4J, CSV, servlet, …​
Provides a MetricRegistry which collects all your app metrics
Provides annotations for AOP frameworks: @Counted, @Timed, …​
…​ but does not include integration with these frameworks
More at dropwizard.github.io/metrics

Discover how we created CDI integration module for Metrics

Metrics out of the box (NO CDI)

class MetricsHelper {
    public static MetricRegistry registry = new MetricRegistry();
}
class TimedMethodClass {
    void timedMethod() {
        Timer timer = MetricsHelper.registry.timer("timer"); (1)
        Timer.Context time = timer.time();
        try { ... }
        finally { time.stop();}
    }
}
1Note that if "timer" Timer doesn’t exist, MetricRegistry will create a default one and register it

Basic CDI integration…​

class MetricRegistryBean {
    @Produces @ApplicationScoped
    MetricRegistry registry = new MetricRegistry();
}
...
class TimedMethodBean {
    @Inject MetricRegistry registry;
    void timedMethod() {
        Timer timer = registry.timer("timer");
        Timer.Context time = timer.time();
        try { ... } finally { time.stop();}
    }
}
We could have a lot more with advanced CDI features

Our goals

  1. Apply a metric with the provided annotation in AOP style
    @Timed("timer") (1)
void timedMethod() {
  ...
}
  2. Register automatically produced custom metrics
    @Produces @Metric(name="myTimer") (1)
Timer timer = new Timer(new SlidingTimeWindowReservoir(1L, TimeUnit.MINUTES));
...
@Timed("myTimer") (1)
void timedMethod() { ... }
    1Annotations provided by Metrics

Steps to apply a timer in AOP style

Create an interceptor for the timer technical code
Make the Metrics annotation @Timed a valid interceptor binding annotation
Programmatically add @Timed as an interceptor binding
Use the Magic

Preparing interceptor creation

To create an interceptor we should start by detecting the "technical code" that will wrap the "business code"
class TimedMethodBean {
    @Inject MetricRegistry registry;
    void timedMethod() {
        Timer timer = registry.timer("timer");
        Timer.Context time = timer.time();
        try { //business code }
        finally { time.stop(); }
    }
}

Creating the interceptor

Interceptor is an independent specification (JSR 318).
Highlighted code below is part of it.
@Interceptor
class TimedInterceptor {
    @Inject MetricRegistry registry; (1)
    @AroundInvoke
    Object timeMethod(InvocationContext context) throws Exception {
        String name = context.getMethod().getAnnotation(Timed.class).name();
        Timer timer = registry.timer(name);
        Timer.Context time = timer.time();
        try { return context.proceed(); } (2)
        finally { time.stop(); }
    }
}
1In CDI an interceptor is a bean: you can inject other beans in it
2Here the "business" of the application is called. All the code around is the technical one

Activating the interceptor

@Interceptor
@Priority(Interceptor.Priority.LIBRARY_BEFORE)  (1)
class TimedInterceptor {
    @Inject MetricRegistry registry;
    @AroundInvoke
    Object timeMethod(InvocationContext context) throws Exception {
        String name = context.getMethod().getAnnotation(Timed.class).name();
        Timer timer = registry.timer(name);
        Timer.Context time = timer.time();
        try { return context.proceed(); }
        finally { time.stop(); }
    }
}
1Giving a @Priority to an interceptor activates it. This annotation is part of the "Common Annotation" specification (JSR 250). In CDI, interceptor activation can also be done in beans.xml file.

Add a binding to the interceptor

@Interceptor
@Timed  (1)
@Priority(Interceptor.Priority.LIBRARY_BEFORE)
class TimedInterceptor {
    @Inject MetricRegistry registry;
    @AroundInvoke
    Object timeMethod(InvocationContext context) throws Exception {
        String name = context.getMethod().getAnnotation(Timed.class).name();
        Timer timer = registry.timer(name);
        Timer.Context time = timer.time();
        try { return context.proceed(); }
        finally { time.stop(); }
    }
}
1We’ll use metrics @Timed annotation as interceptor binding

Back on interceptor binding

An interceptor binding is an annotation used in 2 kind of places:
  1. On the interceptor definitions to associates them to this annotation
  2. On the Methods / Classes we want to be intercepted by this interceptor
An interceptor binding should be annotated with the @InterceptorBinding meta annotation or should be declared as an interceptor binding programmatically
If the interceptor binding annotation has members:
  1. Their values are taken into account to distinguish two instances
  2. Unless members are annotated with @NonBinding

@Timed source code tells us it’s not an interceptor binding

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.ANNOTATION_TYPE })
(1)
public @interface Timed {
    String name() default ""; (2)
    boolean absolute() default false; (2)
}
1Lack of @InterceptorBinding annotation and we have no code to add it programmatically.
2None of the members have the @NonBinding annotation so they’ll be used to distinguish two instances (i.e. @Timed(name="timer1") and @Timed(name="timer2") will be 2 different interceptor bindings)

The needed @Timed to make it an interceptor binding

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.ANNOTATION_TYPE })
@InterceptorBinding
public @interface Timed {
    @NonBinding String name() default "";
    @NonBinding boolean absolute() default false;
}

How to obtain the required @Timed?

Remember the AnnotatedType SPI?

Thanks to DeltaSpike we can easily create the required AnnotatedType
AnnotatedType createTimedAnnotatedType() throws Exception {
    Annotation nonBinding = new AnnotationLiteral<Nonbinding>() {}; (1)
    return new AnnotatedTypeBuilder().readFromType(Timed.class) (2)
        .addToMethod(Timed.class.getMethod("name"), nonBinding) (3)
        .addToMethod(Timed.class.getMethod("absolute"), nonBinding) (3)
        .create();
}
1This creates an instance of @NonBinding annotation
2It would have been possible but far more verbose to create this AnnotatedType without the help of DeltaSpike. The AnnotatedTypeBuilder is initialized with Metrics Timed annotation.
3@NonBinding is added to both members of @Timed annotation

Add @Timed to the list of interceptor binding with an extension

By observing BeforeBeanDiscovery lifecycle event
public interface BeforeBeanDiscovery {
  addQualifier(Class<? extends Annotation> qual);
  addQualifier(AnnotatedType<? extends Annotation> qual);
  addScope(Class<? extends Annotation> scp, boolean nm, boolean psv);
  addStereotype(Class<? extends Annotation> strt, Annotation... sd);
  addInterceptorBinding(AnnotatedType<? extends Annotation> type);  (1)
  addInterceptorBinding(Class<? extends Annotation> type, Annotation... btd);
  addAnnotatedType(AnnotatedType<?> type);
  addAnnotatedType(AnnotatedType<?> type, String id);
}
1This method is the one we need to use for our @Timed AnnotatedType

BeforeBeanDiscovery is first in lifecycle

lifecycle BBD lifecycle legend light

This extension will do the job

class MetricsExtension implements Extension {

    void addTimedBinding(@Observes BeforeBeanDiscovery bbd) throws Exception {
        bbd.addInterceptorBinding(createTimedAnnotatedType());
    }

    private AnnotatedType createTimedAnnotatedType() throws Exception {
        Annotation nonBinding = new AnnotationLiteral<Nonbinding>() {};
        return new AnnotatedTypeBuilder().readFromType(Timed.class)
            .addToMethod(Timed.class.getMethod("name"), nonBinding)
            .addToMethod(Timed.class.getMethod("absolute"), nonBinding)
            .create();
    }
}

First goal achieved

We can now write:
@Timed("timer")
void timedMethod(){
  //Business code
}

And have a Metrics Timer applied to the method

Second goal: Register automatically produced custom metrics

Why would we want custom metrics?

@AroundInvoke
Object timedMethod(InvocationContext context) throws Exception {
    String name = context.getMethod().getAnnotation(Timed.class).name();
    Timer timer = registry.timer(name); (1)
    Timer.Context time = timer.time();
    try {
        return context.proceed();
    } finally { time.stop();}
}
1The registry provide a Default Timer (if none was registered by the user). The default timer histogram is exponentially biased to the past 5 minutes of measurements. We may want to have an other behaviour.

Register automatically produced custom metrics

We want to write this:
@Produces @Metric(name="myTimer")
Timer timer = new Timer(new SlidingTimeWindowReservoir(1L, TimeUnit.MINUTES));
And have:
  1. The possibility to retrieved this metric from the registry when it’s injected (instead of having a new instance created)
  2. This Metric produced when needed (first use)
  3. This Metric registered in the registry with its name (here "myTimer")
There are 2 Metric: the com.codahale.metrics.Metric interface and the com.codahale.metrics.annotation.Metric annotation

How to achieve this?

We need to write an extension that will:
  1. Declare @Metric as a new Qualifier to ease injection and name resolution in a BeforeBeanDiscovery observer
  2. Change how a Metric instance will be produced to look for it in the registry and produce (and register) it only if it’s not found. We’ll do this by:
    1. observing the ProcessProducer lifecycle event
    2. decorating Metric Producer to add this new behaviour.
  3. Produce all Metric at the end of boot time to have them in registry for runtime
    1. we’ll do this by observing AfterDeploymentValidation event

So we will @Observes these 3 events to add our features

lifecycle BBD PP ADV lifecycle legend light

Adding @Metric to the list of qualifiers

This time we need annotation members to be binding (@Metric("a") and @Metric("b") should be distinguished)
So we don’t have to add @Nonbinding annotation on them
public class MetricExtension implements Extension {

    void addMetricQualifier(@Observes BeforeBeanDiscovery bbd) {
        bbd.addQualifier(Metric.class);
    }
    ...
}

Customizing Metric producing process

We first need to create our implementation of Producer<T> SPI
public class MetricProducer implements Producer<com.codahale.metrics.Metric> {

        private Producer<com.codahale.metrics.Metric> decorated;
        private BeanManager bm;
        private String name;

        public MetricProducer(Producer<com.codahale.metrics.Metric> decorated, String name, BeanManager bm) {
            this.decorated = decorated;
            this.bm = bm;
            this.name = name;
        }

        MetricRegistry getRegistry() {
            return BeanProvider.getContextualReference(bm, MetricRegistry.class, false); (1)
        }
...
1BeanProvider is a DeltaSpike helper class to easily retrieve a bean or bean instance

Customizing Metric producing process (continued)

...
        @Override
        public com.codahale.metrics.Metric produce(CreationalContext<com.codahale.metrics.Metric> ctx) {
            MetricRegistry reg = getRegistry();
            if (!reg.getMetrics().containsKey(name))
                reg.register(name, decorated.produce(ctx));
            return reg.getMetrics().get(name);
        }

        @Override
        public void dispose(com.codahale.metrics.Metric instance) { } (1)

        @Override
        public Set<InjectionPoint> getInjectionPoints() {
            return decorated.getInjectionPoints();
        }
    }
1We don’t want to have the produced metric destroyed by CDI container

We’ll use our Producer<Metric> in a ProcessProducer observer

Thru this event we can substitute the standard producer by ours
public interface ProcessProducer<T, X> {
    public AnnotatedMember<T> getAnnotatedMember(); (1)

    public Producer<X> getProducer(); (2)

    public void setProducer(Producer<X> producer); (3)

    public void addDefinitionError(Throwable t);
}
1Used to retrieve annotations associated to @Produces
2Get the default producer (useful to decorate it)
3Change the producer by ours

Customizing Metric producing process (end)

Here’s the extension code to do this producer decoration
public class MetricExtension implements Extension {
...
    void reproduceMetric(@Observes ProcessProducer<?, com.codahale.metrics.Metric> pp,
                         BeanManager bm) {

        String name = pp.getAnnotatedMember().getAnnotation(Metric.class).name();
        pp.setProducer(new MetricProducer(pp.getProducer(),name,bm));
    }
...
}

Producing all the Metric at the end of boot time

We do that by observing the AfterDeploymentValidation event
public class MetricExtension implements Extension {
...
    void regMetrics(@Observes AfterDeploymentValidation adv, BeanManager bm) {
        Set<Bean<?>> metricBeans = bm.getBeans(com.codahale.metrics.Metric.class, new AnyLiteral()); (1)
        for (Bean<?> bean : metricBeans) {
            Metric qual = AnnotationUtils.findAnnotation(bm, (Annotation[])(bean.getQualifiers().toArray()), Metric.class);
            String name = qual.name(); (2)
            BeanProvider.getContextualReference(bm, com.codahale.metrics.Metric.class, false, qual); (3)
        }
...
}
1Getting all the Metric beans
2Retrieving its name from bean qualifiers
3Requesting an instance that will use our custom producer and thus will fill the registry

Second Goal achieved

We can now write:
@Produces @Metric(name="myTimer")
Timer timer = new Timer(new SlidingTimeWindowReservoir(1L, TimeUnit.MINUTES));

@Inject
MetricRegistry registry;

@Inject @Metric("myTimer")
Metric timer;
And be sure that registry.getMetrics.get("myTimer") and timer are the same object (our custom Timer)

Complete extension code

public class MetricExtension implements Extension {

    void reproduceMetric(@Observes ProcessProducer<?, com.codahale.metrics.Metric> pp, BeanManager bm) {
        String name = pp.getAnnotatedMember().getAnnotation(Metric.class).name();
        pp.setProducer(new MetricProducer(pp.getProducer(),name,bm));
    }
    void addTimedBinding(@Observes BeforeBeanDiscovery bbd) throws Exception {
        bbd.addInterceptorBinding(createTimedAnnotatedType());
    }
    private AnnotatedType createTimedAnnotatedType() throws Exception {
        Annotation nonBinding = new AnnotationLiteral<Nonbinding>() {};
        return new AnnotatedTypeBuilder().readFromType(Timed.class)
                .addToMethod(Timed.class.getMethod("name"), nonBinding)
                .addToMethod(Timed.class.getMethod("absolute"), nonBinding).create();
    }
    void addMetricQualifier(@Observes BeforeBeanDiscovery bbd) { bbd.addQualifier(Metric.class); }
    void regMetrics(@Observes AfterDeploymentValidation adv, BeanManager bm) {
        Set<Bean<?>> metricBeans = bm.getBeans(com.codahale.metrics.Metric.class, new AnyLiteral());
        for (Bean<?> bean : metricBeans) {
            Metric qual = AnnotationUtils.findAnnotation(bm, (Annotation[])(bean.getQualifiers().toArray()), Metric.class);
            String name = qual.name();
            BeanProvider.getContextualReference(bm, com.codahale.metrics.Metric.class, false, qual);
        }
    }
}

Quizz time

Test your CDI knowledge

Find the valid injections points

public class MySuperBean {
    
    

    @Inject
    Bean<MySuperBean> myMeta;                                // A [ ]

    

    @Inject
    Bean<MyService> serviceMeta;                             // B [ ]


    public MySuperBean(@Inject MyService service) {...}      // C [ ]

    @Inject
    private void myInitMethod(MyService service) {...}       // D [ ]
    


    @Inject
    @PostConstruct 

    public void myInitMethod2(MyService service) {...}       // E [ ]

}

Solution

public class MySuperBean {
    
    

    @Inject
    Bean<MySuperBean> myMeta;                                // A [X]

    

    @Inject
    Bean<MyService> serviceMeta;                             // B [ ]


    public MySuperBean(@Inject MyService service) {...}      // C [ ]

    @Inject
    private void myInitMethod(MyService service) {...}       // D [X]
    


    @Inject
    @PostConstruct 

    public void myInitMethod2(MyService service) {...}       // E [ ]

}

Find Beans candidates without beans.xml in jar (CDI 1.2)

@Decorator
public abstract class MyDecorator implements MyService{}  //A [ ]

@Stateless
public class MyServiceImpl implements MyService{}         //B [ ]

public class MyBean {}                                    //C [ ]

@Model
public class MyBean {}                                    //D [ ]

@Singleton
public class MyBean {}                                    //E [ ]

@ConversationScoped
public class MyBean {}                                    //F [ ]

Solution

@Decorator
public abstract class MyDecorator implements MyService{}  //A [X]

@Stateless
public class MyServiceImpl implements MyService{}         //B [X]

public class MyBean {}                                    //C [ ]

@Model
public class MyBean {}                                    //D [X]

@Singleton
public class MyBean {}                                    //E [ ]

@ConversationScoped
public class MyBean {}                                    //F [X]

Find the valid producers

@ApplicationScoped

public class MyBean {
    


    @Produces 

    public Service produce1(InjectionPoint ip, Bean<Service> myMeta) {...}   // A [ ]



    @Produces 

    @SessionScoped 

    public Service produce2(InjectionPoint ip) {...}                         // B [ ]

    @Produces 

    public Map<K, V> produceMap(InjectionPoint ip) {...}                     // C [ ]

    @Produces 

    public Map<String, ? extends Service> produceMap2() {...}                // D [ ]
}

Solution

@ApplicationScoped

public class MyBean {
    


    @Produces 

    public Service produce1(InjectionPoint ip, Bean<Service> myMeta) {...}   // A [X]



    @Produces 

    @SessionScoped 

    public Service produce2(InjectionPoint ip) {...}                         // B [ ]

    @Produces 

    public Map<K, V> produceMap(InjectionPoint ip) {...}                     // C [X]

    @Produces 

    public Map<String, ? extends Service> produceMap2() {...}                // D [ ]
}

Which observers will be triggered?

public class FirstBean {
    

    @Inject 

    Event<Post> postEvent;


    public void saveNewPost(Post myPost) {

        postEvent.select(new AnnotationLiteral() < French > {}).fire(myPost);

    }
}



public class SecondBean {
    

    public void listenFrPost(@Observes @French Post post) {...}   // A
    public void listenPost(@Observes Post post) {...}             // B
    public void listenEnPost(@Observes @English Post post) {...}  // C
    public void listenObject(@Observes Object obj) {...}          // D
}

Solution

public class FirstBean {
    

    @Inject 

    Event<Post> postEvent;


    public void saveNewPost(Post myPost) {

        postEvent.select(new AnnotationLiteral() < French > {}).fire(myPost);

    }
}



public class SecondBean {
    

    public void listenFrPost(@Observes @French Post post) {...}   // A [X]
    public void listenPost(@Observes Post post) {...}             // B [X]

    public void listenEnPost(@Observes @English Post post) {...}  // C

    public void listenObject(@Observes Object obj) {...}          // D [X]
}

Camel CDI

How to use CDI as dependency injection container for an integration framework (Apache Camel)

About Apache Camel

Open-source integration framework based on known Enterprise Integration Patterns
Provides a variety of DSLs to write routing and mediation rules
Provides support for bean binding and seamless integration with DI frameworks
eip

Discover how we created CDI integration module for Camel

Camel out of the box (NO CDI)

 public static void main(String[] args) {
    CamelContext context = new DefaultCamelContext();
    context.addRoutes(new RouteBuilder() {
      public void configure() {
        from("file:target/input?delay=1000")
          .convertBodyTo(String.class)
          .log("Sending message [${body}] to JMS ...")
          .to("sjms:queue:output"); (1)
      }
    });
    PropertiesComponent properties = new PropertiesComponent();
    properties.setLocation("classpath:camel.properties");
    context.addComponent("properties", properties); // Registers the "properties" component

    SjmsComponent component = new SjmsComponent();
    component.setConnectionFactory(new ActiveMQConnectionFactory("vm://broker?broker.persistent=false"));
    jms.setConnectionCount(Integer.valueOf(context.resolvePropertyPlaceholders("{{jms.maxConnections}}")));
    context.addComponent("sjms", jms); // Registers the "sjms" component

    context.start();
}
1This route watches a directory every second and sends new files content to a JMS queue

Basic CDI integration 1/3

  1. Camel components and route builder as CDI beans
  2. Bind the Camel context lifecycle to that of the CDI container
class FileToJmsRouteBean extends RouteBuilder {

    @Override
    public void configure() {
        from("file:target/input?delay=1000")
            .convertBodyTo(String.class)
            .log("Sending message [${body}] to JMS...")
            .to("sjms:queue:output");
    }
}

Basic CDI integration 2/3

class PropertiesComponentFactoryBean {

    @Produces
    @ApplicationScoped
    PropertiesComponent propertiesComponent() {
        PropertiesComponent properties = new PropertiesComponent();
        properties.setLocation("classpath:camel.properties");
        return properties;
    }
}
class JmsComponentFactoryBean {

    @Produces
    @ApplicationScoped
    SjmsComponent sjmsComponent(PropertiesComponent properties) throws Exception {
        SjmsComponent jms = new SjmsComponent();
        jms.setConnectionFactory(new ActiveMQConnectionFactory("vm://broker?broker.persistent=false"));
        jms.setConnectionCount(Integer.valueOf(properties.parseUri("{{jms.maxConnections}}")));
        return component;
    }
}

Basic CDI integration 3/3

@ApplicationScoped
class CamelContextBean extends DefaultCamelContext {

    @Inject
    CamelContextBean(FileToJmsRouteBean route, SjmsComponent jms, PropertiesComponent properties) {
        addComponent("properties", properties);
        addComponent("sjms", jms);
        addRoutes(route);
    }
    @PostConstruct
    void startContext() {
        super.start();
    }
    @PreDestroy
    void preDestroy() {
        super.stop();
    }
}
We could have a lot more with advanced CDI features

Our goals

  1. Avoid assembling and configuring the CamelContext manually
  2. Access CDI beans from the Camel DSL automatically
    .to("sjms:queue:output"); // Lookup by name (sjms) and type (Component)

context.resolvePropertyPlaceholders("{{jms.maxConnections}}");
// Lookup by name (properties) and type (Component)
  3. Support Camel annotations in CDI beans
    @PropertyInject(value = "jms.maxConnections", defaultValue = "10")
int maxConnections;

Steps to integrate Camel and CDI

Manage the creation and the configuration of the CamelContext bean
Bind the CamelContext lifecycle that of the CDI container
Implement the Camel SPI to look up CDI bean references
Use a custom InjectionTarget for CDI beans containing Camel annotations
Use the Magic

How to achieve this?

We need to write an extension that will:
  1. Declare a CamelContext bean by observing the AfterBeanDiscovery lifecycle event
  2. Instantiate the beans of type RouteBuilder and add them to the Camel context
  3. Start (resp. stop) the Camel context when the AfterDeploymentValidation event is fired (resp. the BeforeShutdown event)
  4. Customize the Camel context to query the BeanManager to lookup CDI beans by name and type
  5. Detect CDI beans containing Camel annotations by observing the ProcessAnnotatedType event and modify how they get injected by observing the ProcessInjectionTarget lifecycle event

So we will @Observes these 5 events to add our features

lifecycle PAT PIT ABD ADV BS lifecycle legend light

Adding the CamelContext bean

Automatically add a CamelContext bean in the deployment archive

How to add a bean programmatically?

Declaring a bean programmatically

We need to implement the Bean SPI
public interface Bean<T> extends Contextual<T>, BeanAttributes<T> {

    public Class<?> getBeanClass();
    public Set<InjectionPoint> getInjectionPoints();
    public T create(CreationalContext<T> creationalContext); // Contextual<T>
    public void destroy(T instance, CreationalContext<T> creationalContext);
    public Set<Type> getTypes(); // BeanAttributes<T>
    public Set<Annotation> getQualifiers();
    public Class<? extends Annotation> getScope();
    public String getName();
    public Set<Class<? extends Annotation>> getStereotypes();
    public boolean isAlternative();
}

Implementing the Bean SPI

class CamelContextBean implements Bean<CamelContext> {

    public Class<? extends Annotation> getScope() { return ApplicationScoped.class; }

    public Set<Annotation> getQualifiers() {
        return Collections.singleton((Annotation) new AnnotationLiteral<Default>(){});
    }
    public Set<Type> getTypes() { return Collections.singleton((Type) CamelContext.class); }

    public CamelContext create(CreationalContext<CamelContext> creational) {
        return new DefaultCamelContext();
    }
    public void destroy(CamelContext instance, CreationalContext<CamelContext> creational) {}

    public Class<?> getBeanClass() { return DefaultCamelContext.class; }

    public Set<InjectionPoint> getInjectionPoints() { return Collections.emptySet(); }

    public Set<Class<? extends Annotation>> getStereotypes() { return Collections.emptySet(); }
    public String getName() { return "camel-cdi"; }
    public boolean isAlternative() { return false; }
    public boolean isNullable() { return false; }
}

Adding a programmatic bean to the deployment

Then add the CamelContextBean bean programmatically by observing the AfterBeanDiscovery lifecyle event
public class CamelExtension implements Extension {

    void addCamelContextBean(@Observes AfterBeanDiscovery abd) {
        abd.addBean(new CamelContextBean());
    }
}

Instantiate and assemble the Camel context

Instantiate the CamelContext bean and the RouteBuilder beans in the AfterDeploymentValidation lifecycle event
public class CamelExtension implements Extension {
    ...
    void configureContext(@Observes AfterDeploymentValidation adv, BeanManager bm) {
        CamelContext context = getReference(bm, CamelContext.class);
        for (Bean<?> bean : bm.getBeans(RoutesBuilder.class))
            context.addRoutes(getReference(bm, RouteBuilder.class, bean));
    }
    <T> T getReference(BeanManager bm, Class<T> type) {
        return getReference(bm, type, bm.resolve(bm.getBeans(type)));
    }
    <T> T getReference(BeanManager bm, Class<T> type, Bean<?> bean) {
        return (T) bm.getReference(bean, type, bm.createCreationalContext(bean));
    }
}

Managed the Camel context lifecycle

Start (resp. stop) the Camel context when the AfterDeploymentValidation event is fired (resp. the BeforeShutdown)
public class CamelExtension implements Extension {
    ...
    void configureContext(@Observes AfterDeploymentValidation adv, BeanManager bm) {
        CamelContext context = getReference(bm, CamelContext.class);
        for (Bean<?> bean : bm.getBeans(RoutesBuilder.class)
            context.addRoutes(getReference(bm, RouteBuilder.class, bean);
        context.start();
    }
    void stopCamelContext(@Observes BeforeShutdown bs, BeanManager bm) {
        CamelContext context = getReference(bm, CamelContext.class);
        context.stop();
    }
}

First goal achieved

We can get rid of the following code:
@ApplicationScoped
class CamelContextBean extends DefaultCamelContext {
    @Inject
    CamelContextBean(FileToJmsRouteBean route, SjmsComponent jms, PropertiesComponent properties) {
        addComponent("properties", propertiesComponent);
        addComponent("sjms", sjmsComponent);
        addRoutes(route);
    }
    @PostConstruct
    void startContext() {
        super.start();
    }
    @PreDestroy
    void stopContext() {
        super.stop();
    }
}

Second goal: Access CDI beans from the Camel DSL

How to retrieve CDI beans from the Camel DSL?

.to("sjms:queue:output"); // Lookup by name (sjms) and type (Component)
context.resolvePropertyPlaceholders("{{jms.maxConnections}}");
// Lookup by name (properties) and type (Component)

// And also...
.bean(MyBean.class); // Lookup by type and Default qualifier
.beanRef("beanName"); // Lookup by name
Implement the Camel registry SPI and use the BeanManager to lookup for CDI bean contextual references by name and type

Implement the Camel registry SPI

class CamelCdiRegistry implements Registry {
    private final BeanManager bm;

    CamelCdiRegistry(BeanManager bm) { this.bm = bm; }

    public <T> T lookupByNameAndType(String name, Class<T> type) {
        return getReference(bm, type, bm.resolve(bm.getBeans(name)));
    }
    public <T> Set<T> findByType(Class<T> type) {
        return getReference(bm, type, bm.resolve(bm.getBeans(type)));
    }
    public Object lookupByName(String name) {
        return lookupByNameAndType(name, Object.class);
    }
    <T> T getReference(BeanManager bm, Type type, Bean<?> bean) {
        return (T) bm.getReference(bean, type, bm.createCreationalContext(bean));
    }
}

Add the CamelCdiRegistry to the Camel context

class CamelContextBean implements Bean<CamelContext> {
    private final BeanManager bm;

    CamelContextBean(BeanManager bm) { this.bm = bm; }
    ...
    public CamelContext create(CreationalContext<CamelContext> creational) {
        return new DefaultCamelContext(new CamelCdiRegistry(bm));
    }
}
public class CamelExtension implements Extension {
    ...
    void addCamelContextBean(@Observes AfterBeanDiscovery abd , BeanManager bm) {
        abd.addBean(new CamelContextBean(bm));
    }
}

Second goal achieved 1/3

We can declare the sjms component with the @Named qualifier
class JmsComponentFactoryBean {

    @Produces
    @Named("sjms")
    @ApplicationScoped
    SjmsComponent sjmsComponent(PropertiesComponent properties) {
        SjmsComponent jms = new SjmsComponent();
        jms.setConnectionFactory(new ActiveMQConnectionFactory("vm://broker?..."));
        jms.setConnectionCount(Integer.valueOf(properties.parseUri("{{jms.maxConnections}}")));
        return component;
    }
}

…​

Second goal achieved 2/3

Declare the properties component with the @Named qualifier
class PropertiesComponentFactoryBean {

    @Produces
    @Named("properties")
    @ApplicationScoped
    PropertiesComponent propertiesComponent() {
        PropertiesComponent properties = new PropertiesComponent();
        properties.setLocation("classpath:camel.properties");
        return properties;
    }
}

…​

Second goal achieved 3/3

And get rid of the code related to the properties and sjms components registration
@ApplicationScoped
class CamelContextBean extends DefaultCamelContext {
    @Inject
    CamelContextBean(FileToJmsRouteBean route, SjmsComponent jms, PropertiesComponent properties) {
        addComponent("properties", propertiesComponent);
        addComponent("sjms", sjmsComponent);
        addRoutes(route);
    }
    @PostConstruct
    void startContext() {
        super.start();
    }
    @PreDestroy
    void stopContext() {
        super.stop();
    }
}

Third goal: Support Camel annotations in CDI beans

Camel provides a set of DI framework agnostic annotations for resource injection
@PropertyInject(value = "jms.maxConnections", defaultValue = "10")
int maxConnections;

// But also...
@EndpointInject(uri="jms:queue:foo")
Endpoint endpoint;

@BeanInject("foo")
FooBean foo;

How to support custom annotations injection?

How to support custom annotations injection?

Create a custom InjectionTarget that uses the default Camel bean post processor DefaultCamelBeanPostProcessor
public interface InjectionTarget<T> extends Producer<T> {
    public void inject(T instance, CreationalContext<T> ctx);
    public void postConstruct(T instance);
    public void preDestroy(T instance);
}
Hook it into the CDI injection mechanism by observing the ProcessInjectionTarget lifecycle event
Only for beans containing Camel annotations by observing the ProcessAnnotatedType lifecycle and using @WithAnnotations

Create a custom InjectionTarget

class CamelInjectionTarget<T> implements InjectionTarget<T> {

    final InjectionTarget<T> delegate;

    final DefaultCamelBeanPostProcessor processor;

    CamelInjectionTarget(InjectionTarget<T> target, final BeanManager bm) {
        delegate = target;
        processor = new DefaultCamelBeanPostProcessor() {
            public CamelContext getOrLookupCamelContext() {
                return getReference(bm, CamelContext.class);
            }
        };
    }
    public void inject(T instance, CreationalContext<T> ctx) {
        processor.postProcessBeforeInitialization(instance, null); (1)
        delegate.inject(instance, ctx);
    }
    ...
}
1Call the Camel default bean post-processor before CDI injection

Register the custom InjectionTarget

Observe the ProcessInjectionTarget lifecyle event and set the InjectionTarget
public interface ProcessInjectionTarget<X> {
    public AnnotatedType<X> getAnnotatedType();
    public InjectionTarget<X> getInjectionTarget();
    public void setInjectionTarget(InjectionTarget<X> injectionTarget);
    public void addDefinitionError(Throwable t);
}
To decorate it with the CamelInjectionTarget
class CamelExtension implements Extension {

    <T> void camelBeansPostProcessor(@Observes ProcessInjectionTarget<T> pit, BeanManager bm) {
        pit.setInjectionTarget(new CamelInjectionTarget<>(pit.getInjectionTarget(), bm));
    }
}

But only for beans containing Camel annotations

class CamelExtension implements Extension {
    final Set<AnnotatedType<?>> camelBeans = new HashSet<>();

    void camelAnnotatedTypes(@Observes @WithAnnotations(PropertyInject.class)
        ProcessAnnotatedType<?> pat) { (1)
            camelBeans.add(pat.getAnnotatedType());
    }

    <T> void camelBeansPostProcessor(@Observes ProcessInjectionTarget<T> pit,
        BeanManager bm) {
        if (camelBeans.contains(pit.getAnnotatedType())) (2)
            pit.setInjectionTarget(
                new CamelInjectionTarget<>(pit.getInjectionTarget(), bm));
    }
}
1Detect all the types containing Camel annotations with @WithAnnotations
2Decorate the InjectionTarget corresponding to these types

Third goal achieved 1/2

Instead of injecting the PropertiesComponent bean to resolve a configuration property
class JmsComponentFactoryBean {

    @Produces
    @Named("sjms")
    @ApplicationScoped
    SjmsComponent sjmsComponent(PropertiesComponent properties) {
        SjmsComponent jms = new SjmsComponent();
        jms.setConnectionFactory(new ActiveMQConnectionFactory("vm://broker?..."));
        jms.setConnectionCount(Integer.valueOf(properties.parseUri("{{jms.maxConnections}}")));
        return component;
    }
}

Third goal achieved 2/2

We can directly rely on the @PropertyInject Camel annotation in CDI beans
class JmsComponentFactoryBean {

    @PropertyInject(value = "jms.maxConnections", defaultValue = "10")
    int maxConnections;

    @Produces
    @Named("sjms")
    @ApplicationScoped
    SjmsComponent sjmsComponent() {
        SjmsComponent component = new SjmsComponent();
        jms.setConnectionFactory(new ActiveMQConnectionFactory("vm://broker?..."));
        component.setConnectionCount(maxConnections);
        return component;
    }
}

Bonus goal: Camel DSL AOP

AOP instrumentation of the Camel DSL
from("file:target/input?delay=1000")
    .convertBodyTo(String.class)
    .log("Sending message [${body}] to JMS...")
    .to("sjms:queue:output");
with CDI observers
from("file:target/input?delay=1000")
    .convertBodyTo(String.class)
    .to("sjms:queue:output").id("join point");
}
void advice(@Observes @NodeId("join point") Exchange exchange) {
    logger.info("Sending message [{}] to JMS...", exchange.getIn().getBody());
}

How to achieve this?

We can create a CDI qualifier to hold the Camel node id metadata:
@Qualifier
@Retention(RetentionPolicy.RUNTIME)
public @interface NodeId {
    String value();
}
and create an extension that will:
  1. Detect the CDI beans containing observer methods with the @NodeId qualifier by observing the ProcessObserverMethod event and collect the Camel processor nodes to be instrumented
  2. Customize the Camel context by providing an implementation of the Camel InterceptStrategy interface that will fire a CDI event each time an Exchange is processed by the instrumented nodes

Detect the Camel DSL AOP observer methods

Observe the ProcessObserverMethod lifecyle event
public interface ProcessObserverMethod<T, X> {
    public AnnotatedMethod<X> getAnnotatedMethod();
    public ObserverMethod<T> getObserverMethod();
    public void addDefinitionError(Throwable t);
}
And collect the observer method metadata
class CamelExtension implements Extension {
    final Set<NodeId> joinPoints = new HashSet<>();

    void pointcuts(@Observes ProcessObserverMethod<Exchange, ?> pom) {
        for (Annotation qualifier : pom.getObserverMethod().getObservedQualifiers())
            if (qualifier instanceof NodeId)
                joinPoints.add(NodeId.class.cast(qualifier));
    }
}

Instrument the Camel context

Intercept matching nodes and fire a CDI event
void configureCamelContext(@Observes AfterDeploymentValidation adv, final BeanManager manager) {
    context.addInterceptStrategy(new InterceptStrategy() {
      public Processor wrapProcessorInInterceptors(CamelContext context, ProcessorDefinition<?> definition,
          Processor target, Processor nextTarget) throws Exception {
            if (definition.hasCustomIdAssigned()) {
                for (final Node node : joinPoints) {
                    if (node.value().equals(definition.getId())) {
                        return new DelegateAsyncProcessor(target) {
                            public boolean process(Exchange exchange, AsyncCallback callback) {
                                manager.fireEvent(exchange, node);
                                return super.process(exchange, callback);
                            }
                        };
                    }
                }
            }
            return target;
        }
    });
}

Bonus goal achieved

We can define join points in the Camel DSL
from("file:target/input?delay=1000")
    .convertBodyTo(String.class)
    .to("sjms:queue:output").id("join point");
}
And advise them with CDI observers
void advice(@Observes @NodeId("join point") Exchange exchange) {
    List<MessageHistory> history = exchange.getProperty(Exchange.MESSAGE_HISTORY, List.class);
    logger.info("Sending message [{}] to [{}]...", exchange.getIn().getBody(),
        history.get(history.size() - 1).getNode().getLabel());
}

Conclusion

References

CDI Specification - cdi-spec.org
Metrics CDI sources - github.com/astefanutti/metrics-cdi
Camel CDI sources - github.com/astefanutti/camel-cdi
Slides sources - github.com/astefanutti/further-cdi
Slides generated with Asciidoctor, PlantUML and DZSlides backend
Original slide template - Dan Allen & Sarah White

Antoine Sabot-Durand Antonin Stefanutti

@antoine_sd @astefanut

Annexes

Complete Lifecycle Events

lifecycle complete